MapLibre Native for Android/com.mapbox.mapboxsdk.offline/OfflineRegionStatus

OfflineRegionStatus

A region's status includes its active/inactive state as well as counts of the number of resources that have completed downloading, their total size in bytes, and the total number of resources that are required.

Note that the total required size in bytes is not currently available. A future API release may provide an estimate of this number.

Properties

completedResourceCount

val completedResourceCount: Long

The number of resources (inclusive of tiles) that have been fully downloaded and are ready for offline access.

completedResourceSize

val completedResourceSize: Long

The cumulative size, in bytes, of all resources (inclusive of tiles) that have been fully downloaded.

completedTileCount

val completedTileCount: Long

The number of tiles that have been fully downloaded and are ready for offline access.

completedTileSize

val completedTileSize: Long

The cumulative size, in bytes, of all tiles that have been fully downloaded.

downloadState

val downloadState: Int

Returns the download state.

isComplete

val isComplete: Boolean

Validates if the region download has completed

isRequiredResourceCountPrecise

val isRequiredResourceCountPrecise: Boolean

This property is true when the value of requiredResourceCount is a precise count of the number of required resources, and false when it is merely a lower bound.

requiredResourceCount

val requiredResourceCount: Long

The number of resources that are known to be required for this region. See the documentation for requiredResourceCountIsPrecise for an important caveat about this number.